home *** CD-ROM | disk | FTP | other *** search
/ Mac-Source 1994 July / Mac-Source_July_1994.iso / Other Langs / Tickle-4.0 (tcl) / tcl / extend / src / random.c < prev    next >
Encoding:
C/C++ Source or Header  |  1993-11-06  |  13.6 KB  |  392 lines  |  [TEXT/MPS ]
  1. #ifdef MPW
  2. #    pragma segment TCLExtend
  3. #endif
  4. /*
  5.  * random.c
  6.  *
  7.  * BSD random function to support the TclX random command on SysV based
  8.  * systems.
  9.  *-----------------------------------------------------------------------------
  10.  * $Id: random.c,v 1.1 1993/07/11 19:28:29 markd Exp $
  11.  *-----------------------------------------------------------------------------
  12.  */
  13.  
  14.  
  15. /*
  16.  * Copyright (c) 1983 Regents of the University of California.
  17.  * All rights reserved.
  18.  *
  19.  * Redistribution and use in source and binary forms, with or without
  20.  * modification, are permitted provided that the following conditions
  21.  * are met:
  22.  * 1. Redistributions of source code must retain the above copyright
  23.  *    notice, this list of conditions and the following disclaimer.
  24.  * 2. Redistributions in binary form must reproduce the above copyright
  25.  *    notice, this list of conditions and the following disclaimer in the
  26.  *    documentation and/or other materials provided with the distribution.
  27.  * 3. All advertising materials mentioning features or use of this software
  28.  *    must display the following acknowledgement:
  29.  *    This product includes software developed by the University of
  30.  *    California, Berkeley and its contributors.
  31.  * 4. Neither the name of the University nor the names of its contributors
  32.  *    may be used to endorse or promote products derived from this software
  33.  *    without specific prior written permission.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  36.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  38.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  39.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  40.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  41.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  42.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  43.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  44.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  45.  * SUCH DAMAGE.
  46.  */
  47.  
  48. /*
  49.  * static char sccsid[] = "@(#)random.c    5.9 (Berkeley) 2/23/91";
  50.  */
  51.  
  52.  
  53. #include <stdio.h>
  54.  
  55. long random();
  56.  
  57. typedef unsigned int u_int;
  58.  
  59. #ifdef macintosh
  60.     extern mac_fprintf(FILE *fp, char *format, ...);
  61. #endif
  62.  
  63. /*
  64.  * random.c:
  65.  *
  66.  * An improved random number generation package.  In addition to the standard
  67.  * rand()/srand() like interface, this package also has a special state info
  68.  * interface.  The initstate() routine is called with a seed, an array of
  69.  * bytes, and a count of how many bytes are being passed in; this array is
  70.  * then initialized to contain information for random number generation with
  71.  * that much state information.  Good sizes for the amount of state
  72.  * information are 32, 64, 128, and 256 bytes.  The state can be switched by
  73.  * calling the setstate() routine with the same array as was initiallized
  74.  * with initstate().  By default, the package runs with 128 bytes of state
  75.  * information and generates far better random numbers than a linear
  76.  * congruential generator.  If the amount of state information is less than
  77.  * 32 bytes, a simple linear congruential R.N.G. is used.
  78.  *
  79.  * Internally, the state information is treated as an array of longs; the
  80.  * zeroeth element of the array is the type of R.N.G. being used (small
  81.  * integer); the remainder of the array is the state information for the
  82.  * R.N.G.  Thus, 32 bytes of state information will give 7 longs worth of
  83.  * state information, which will allow a degree seven polynomial.  (Note:
  84.  * the zeroeth word of state information also has some other information
  85.  * stored in it -- see setstate() for details).
  86.  * 
  87.  * The random number generation technique is a linear feedback shift register
  88.  * approach, employing trinomials (since there are fewer terms to sum up that
  89.  * way).  In this approach, the least significant bit of all the numbers in
  90.  * the state table will act as a linear feedback shift register, and will
  91.  * have period 2^deg - 1 (where deg is the degree of the polynomial being
  92.  * used, assuming that the polynomial is irreducible and primitive).  The
  93.  * higher order bits will have longer periods, since their values are also
  94.  * influenced by pseudo-random carries out of the lower bits.  The total
  95.  * period of the generator is approximately deg*(2**deg - 1); thus doubling
  96.  * the amount of state information has a vast influence on the period of the
  97.  * generator.  Note: the deg*(2**deg - 1) is an approximation only good for
  98.  * large deg, when the period of the shift register is the dominant factor.
  99.  * With deg equal to seven, the period is actually much longer than the
  100.  * 7*(2**7 - 1) predicted by this formula.
  101.  */
  102.  
  103. /*
  104.  * For each of the currently supported random number generators, we have a
  105.  * break value on the amount of state information (you need at least this
  106.  * many bytes of state info to support this random number generator), a degree
  107.  * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
  108.  * the separation between the two lower order coefficients of the trinomial.
  109.  */
  110. #define    TYPE_0        0        /* linear congruential */
  111. #define    BREAK_0        8
  112. #define    DEG_0        0
  113. #define    SEP_0        0
  114.  
  115. #define    TYPE_1        1        /* x**7 + x**3 + 1 */
  116. #define    BREAK_1        32
  117. #define    DEG_1        7
  118. #define    SEP_1        3
  119.  
  120. #define    TYPE_2        2        /* x**15 + x + 1 */
  121. #define    BREAK_2        64
  122. #define    DEG_2        15
  123. #define    SEP_2        1
  124.  
  125. #define    TYPE_3        3        /* x**31 + x**3 + 1 */
  126. #define    BREAK_3        128
  127. #define    DEG_3        31
  128. #define    SEP_3        3
  129.  
  130. #define    TYPE_4        4        /* x**63 + x + 1 */
  131. #define    BREAK_4        256
  132. #define    DEG_4        63
  133. #define    SEP_4        1
  134.  
  135. /*
  136.  * Array versions of the above information to make code run faster --
  137.  * relies on fact that TYPE_i == i.
  138.  */
  139. #define    MAX_TYPES    5        /* max number of types above */
  140.  
  141. static int degrees[MAX_TYPES] =    { DEG_0, DEG_1, DEG_2, DEG_3, DEG_4 };
  142. static int seps [MAX_TYPES] =    { SEP_0, SEP_1, SEP_2, SEP_3, SEP_4 };
  143.  
  144. /*
  145.  * Initially, everything is set up as if from:
  146.  *
  147.  *    initstate(1, &randtbl, 128);
  148.  *
  149.  * Note that this initialization takes advantage of the fact that srandom()
  150.  * advances the front and rear pointers 10*rand_deg times, and hence the
  151.  * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
  152.  * element of the state information, which contains info about the current
  153.  * position of the rear pointer is just
  154.  *
  155.  *    MAX_TYPES * (rptr - state) + TYPE_3 == TYPE_3.
  156.  */
  157.  
  158. static long randtbl[DEG_3 + 1] = {
  159.     TYPE_3,
  160.     0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342, 0xde3b81e0, 0xdf0a6fb5,
  161.     0xf103bc02, 0x48f340fb, 0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd,
  162.     0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86, 0xda672e2a, 0x1588ca88,
  163.     0xe369735d, 0x904f35f7, 0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc,
  164.     0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b, 0xf5ad9d0e, 0x8999220b,
  165.     0x27fb47b9,
  166. };
  167.  
  168. /*
  169.  * fptr and rptr are two pointers into the state info, a front and a rear
  170.  * pointer.  These two pointers are always rand_sep places aparts, as they
  171.  * cycle cyclically through the state information.  (Yes, this does mean we
  172.  * could get away with just one pointer, but the code for random() is more
  173.  * efficient this way).  The pointers are left positioned as they would be
  174.  * from the call
  175.  *
  176.  *    initstate(1, randtbl, 128);
  177.  *
  178.  * (The position of the rear pointer, rptr, is really 0 (as explained above
  179.  * in the initialization of randtbl) because the state table pointer is set
  180.  * to point to randtbl[1] (as explained below).
  181.  */
  182. static long *fptr = &randtbl[SEP_3 + 1];
  183. static long *rptr = &randtbl[1];
  184.  
  185. /*
  186.  * The following things are the pointer to the state information table, the
  187.  * type of the current generator, the degree of the current polynomial being
  188.  * used, and the separation between the two pointers.  Note that for efficiency
  189.  * of random(), we remember the first location of the state information, not
  190.  * the zeroeth.  Hence it is valid to access state[-1], which is used to
  191.  * store the type of the R.N.G.  Also, we remember the last location, since
  192.  * this is more efficient than indexing every time to find the address of
  193.  * the last element to see if the front and rear pointers have wrapped.
  194.  */
  195. static long *state = &randtbl[1];
  196. static int rand_type = TYPE_3;
  197. static int rand_deg = DEG_3;
  198. static int rand_sep = SEP_3;
  199. static long *end_ptr = &randtbl[DEG_3 + 1];
  200.  
  201. /*
  202.  * srandom:
  203.  *
  204.  * Initialize the random number generator based on the given seed.  If the
  205.  * type is the trivial no-state-information type, just remember the seed.
  206.  * Otherwise, initializes state[] based on the given "seed" via a linear
  207.  * congruential generator.  Then, the pointers are set to known locations
  208.  * that are exactly rand_sep places apart.  Lastly, it cycles the state
  209.  * information a given number of times to get rid of any initial dependencies
  210.  * introduced by the L.C.R.N.G.  Note that the initialization of randtbl[]
  211.  * for default usage relies on values produced by this routine.
  212.  */
  213. void
  214. srandom(x)
  215.     u_int x;
  216. {
  217.     register int i, j;
  218.  
  219.     if (rand_type == TYPE_0)
  220.         state[0] = x;
  221.     else {
  222.         j = 1;
  223.         state[0] = x;
  224.         for (i = 1; i < rand_deg; i++)
  225.             state[i] = 1103515245 * state[i - 1] + 12345;
  226.         fptr = &state[rand_sep];
  227.         rptr = &state[0];
  228.         for (i = 0; i < 10 * rand_deg; i++)
  229.             (void)random();
  230.     }
  231. }
  232.  
  233. /*
  234.  * initstate:
  235.  *
  236.  * Initialize the state information in the given array of n bytes for future
  237.  * random number generation.  Based on the number of bytes we are given, and
  238.  * the break values for the different R.N.G.'s, we choose the best (largest)
  239.  * one we can and set things up for it.  srandom() is then called to
  240.  * initialize the state information.
  241.  * 
  242.  * Note that on return from srandom(), we set state[-1] to be the type
  243.  * multiplexed with the current value of the rear pointer; this is so
  244.  * successive calls to initstate() won't lose this information and will be
  245.  * able to restart with setstate().
  246.  * 
  247.  * Note: the first thing we do is save the current state, if any, just like
  248.  * setstate() so that it doesn't matter when initstate is called.
  249.  *
  250.  * Returns a pointer to the old state.
  251.  */
  252. char *
  253. initstate(seed, arg_state, n)
  254.     u_int seed;            /* seed for R.N.G. */
  255.     char *arg_state;        /* pointer to state array */
  256.     int n;                /* # bytes of state info */
  257. {
  258.     register char *ostate = (char *)(&state[-1]);
  259.  
  260.     if (rand_type == TYPE_0)
  261.         state[-1] = rand_type;
  262.     else
  263.         state[-1] = MAX_TYPES * (rptr - state) + rand_type;
  264.     if (n < BREAK_0) {
  265. #ifdef macintosh
  266.         mac_fprintf(stderr, "random: not enough state (%d bytes); ignored.\n", n);
  267. #else
  268.         fprintf(stderr, "random: not enough state (%d bytes); ignored.\n", n);
  269. #endif
  270.         return(0);
  271.     }
  272.     if (n < BREAK_1) {
  273.         rand_type = TYPE_0;
  274.         rand_deg = DEG_0;
  275.         rand_sep = SEP_0;
  276.     } else if (n < BREAK_2) {
  277.         rand_type = TYPE_1;
  278.         rand_deg = DEG_1;
  279.         rand_sep = SEP_1;
  280.     } else if (n < BREAK_3) {
  281.         rand_type = TYPE_2;
  282.         rand_deg = DEG_2;
  283.         rand_sep = SEP_2;
  284.     } else if (n < BREAK_4) {
  285.         rand_type = TYPE_3;
  286.         rand_deg = DEG_3;
  287.         rand_sep = SEP_3;
  288.     } else {
  289.         rand_type = TYPE_4;
  290.         rand_deg = DEG_4;
  291.         rand_sep = SEP_4;
  292.     }
  293.     state = &(((long *)arg_state)[1]);    /* first location */
  294.     end_ptr = &state[rand_deg];    /* must set end_ptr before srandom */
  295.     srandom(seed);
  296.     if (rand_type == TYPE_0)
  297.         state[-1] = rand_type;
  298.     else
  299.         state[-1] = MAX_TYPES*(rptr - state) + rand_type;
  300.     return(ostate);
  301. }
  302.  
  303. /*
  304.  * setstate:
  305.  *
  306.  * Restore the state from the given state array.
  307.  *
  308.  * Note: it is important that we also remember the locations of the pointers
  309.  * in the current state information, and restore the locations of the pointers
  310.  * from the old state information.  This is done by multiplexing the pointer
  311.  * location into the zeroeth word of the state information.
  312.  *
  313.  * Note that due to the order in which things are done, it is OK to call
  314.  * setstate() with the same state as the current state.
  315.  *
  316.  * Returns a pointer to the old state information.
  317.  */
  318. char *
  319. setstate(arg_state)
  320.     char *arg_state;
  321. {
  322.     register long *new_state = (long *)arg_state;
  323.     register int type = new_state[0] % MAX_TYPES;
  324.     register int rear = new_state[0] / MAX_TYPES;
  325.     char *ostate = (char *)(&state[-1]);
  326.  
  327.     if (rand_type == TYPE_0)
  328.         state[-1] = rand_type;
  329.     else
  330.         state[-1] = MAX_TYPES * (rptr - state) + rand_type;
  331.     switch(type) {
  332.     case TYPE_0:
  333.     case TYPE_1:
  334.     case TYPE_2:
  335.     case TYPE_3:
  336.     case TYPE_4:
  337.         rand_type = type;
  338.         rand_deg = degrees[type];
  339.         rand_sep = seps[type];
  340.         break;
  341.     default:
  342. #ifdef macintosh
  343.         mac_fprintf(stderr, "random: state info corrupted; not changed.\n");
  344. #else
  345.         fprintf(stderr, "random: state info corrupted; not changed.\n");
  346. #endif
  347.     }
  348.     state = &new_state[1];
  349.     if (rand_type != TYPE_0) {
  350.         rptr = &state[rear];
  351.         fptr = &state[(rear + rand_sep) % rand_deg];
  352.     }
  353.     end_ptr = &state[rand_deg];        /* set end_ptr too */
  354.     return(ostate);
  355. }
  356.  
  357. /*
  358.  * random:
  359.  *
  360.  * If we are using the trivial TYPE_0 R.N.G., just do the old linear
  361.  * congruential bit.  Otherwise, we do our fancy trinomial stuff, which is
  362.  * the same in all the other cases due to all the global variables that have
  363.  * been set up.  The basic operation is to add the number at the rear pointer
  364.  * into the one at the front pointer.  Then both pointers are advanced to
  365.  * the next location cyclically in the table.  The value returned is the sum
  366.  * generated, reduced to 31 bits by throwing away the "least random" low bit.
  367.  *
  368.  * Note: the code takes advantage of the fact that both the front and
  369.  * rear pointers can't wrap on the same call by not testing the rear
  370.  * pointer if the front one has wrapped.
  371.  *
  372.  * Returns a 31-bit random number.
  373.  */
  374. long
  375. random()
  376. {
  377.     long i;
  378.  
  379.     if (rand_type == TYPE_0)
  380.         i = state[0] = (state[0] * 1103515245 + 12345) & 0x7fffffff;
  381.     else {
  382.         *fptr += *rptr;
  383.         i = (*fptr >> 1) & 0x7fffffff;    /* chucking least random bit */
  384.         if (++fptr >= end_ptr) {
  385.             fptr = state;
  386.             ++rptr;
  387.         } else if (++rptr >= end_ptr)
  388.             rptr = state;
  389.     }
  390.     return(i);
  391. }
  392.